/**
 * Copyright 2011 Honeywell Federal Manufacturing & Technologies, LLC. This material was produced under U.S. Government
 * contract DE-ACO4-01AL66850, Honeywell Federal Manufacturing & Technologies, LLC, (FM&T) with the U. S. Department of
 * Energy for the operation of the Kansas City Plant . The U.S. Government has rights to use, reproduce, and distribute
 * this software.  NEITHER THE GOVERNMENT NOR Honeywell Federal Manufacturing & Technologies, LLC, MAKES ANY WARRANTY,
 * EXPRESS OR IMPLIED, OR ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE.  If software is modified to produce
 * derivative works, such modified software should be clearly marked, so as not to confuse it with the version available
 * from FM&T.
 *
 * Additionally, this program is free software; you can redistribute it and/or modify it under the terms of the GNU
 * General Public License Version 3 published by the Free Software Foundation. Accordingly, this program is distributed in
 * the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this library.
 * If not, see http://www.gnu.org/licenses/.
 */
package org.braintrain.tapestry.services;

import com.kcp.ko.fmtnmlib.tapestry.services.GenericEngineServiceAdapter;
import org.braintrain.tapestry.aso.Visit;

/**
 * An extension of the GenericEngineServiceAdapter made for BrainTrain in order to handle discrepancies between
 * visit objects
 * 
 * @author Robert H. Engelhardt
 *
 */
public abstract class BrainTrainEngineServiceAdapter extends GenericEngineServiceAdapter {
	
	/**
	 * Acquire the application visit
	 * @return the application visit
	 */
	protected Visit getBraintrainVisit() {
		return ( Visit ) getApplicationStateManager().get("visit");
	}
	
	/**
	 * Runtime protection from using invalid visit
	 * @return the application visit
	 * @throws Throws a RunTimeException in all cases
	 */
	@Deprecated
	@Override
	public com.kcp.ko.fmtnmlib.tapestry.aso.Visit getVisit() {
		throw new RuntimeException(getName() + " attempted to retriver improper visit.");
	}

}
